Deny unused results, warn on missing docs (except auto/)

And add basic docs for our manually implemented functions.

diff --git a/rust-bindings/rust/src/checksum.rs b/rust-bindings/rust/src/checksum.rs
index 83bb44b9c37b779678c712224d5311f9ef487e4a..454c98849af712ea2f33b17e60a80d61c56d893a 100644 (file)
--- a/rust-bindings/rust/src/checksum.rs
+++ b/rust-bindings/rust/src/checksum.rs
@@ -19,10 +19,13 @@ fn base64_config() -> &'static radix64::CustomConfig {
     })
 }
 
+/// Error returned from parsing a checksum.
 #[derive(Debug, thiserror::Error)]
 pub enum ChecksumError {
+    /// Invalid hex checksum string.
     #[error("invalid hex checksum string")]
     InvalidHexString,
+    /// Invalid base64 checksum string
     #[error("invalid base64 checksum string")]
     InvalidBase64String,
 }

diff --git a/rust-bindings/rust/src/functions.rs b/rust-bindings/rust/src/functions.rs
index c6eb2c5eed0a24a72229432715c4108ef650e7dd..a30ea7bf0f1fd91f2c87c58f1d6e197ff595bc03 100644 (file)
--- a/rust-bindings/rust/src/functions.rs
+++ b/rust-bindings/rust/src/functions.rs
@@ -5,6 +5,7 @@ use glib::{prelude::*, translate::*};
 use glib_sys::GFALSE;
 use std::{future::Future, mem::MaybeUninit, pin::Pin, ptr};
 
+/// Compute the SHA-256 checksum of a file.
 pub fn checksum_file<P: IsA<gio::File>, Q: IsA<gio::Cancellable>>(
     f: &P,
     objtype: ObjectType,
@@ -24,6 +25,7 @@ pub fn checksum_file<P: IsA<gio::File>, Q: IsA<gio::Cancellable>>(
     }
 }
 
+/// Asynchronously compute the SHA-256 checksum of a file.
 pub fn checksum_file_async<
     P: IsA<gio::File>,
     Q: IsA<gio::Cancellable>,
@@ -69,6 +71,7 @@ pub fn checksum_file_async<
     }
 }
 
+/// Asynchronously compute the SHA-256 checksum of a file.
 #[allow(clippy::type_complexity)]
 pub fn checksum_file_async_future<P: IsA<gio::File> + Clone + 'static>(
     f: &P,
@@ -83,6 +86,7 @@ pub fn checksum_file_async_future<P: IsA<gio::File> + Clone + 'static>(
     }))
 }
 
+/// Compute the OSTree checksum of a content object.
 pub fn checksum_file_from_input<P: IsA<gio::InputStream>, Q: IsA<gio::Cancellable>>(
     file_info: &gio::FileInfo,
     xattrs: Option<&glib::Variant>,

diff --git a/rust-bindings/rust/src/lib.rs b/rust-bindings/rust/src/lib.rs
index 11b362907bbb332fe2a2b73085e987eb973ea139..8b065dc7839d7d2ce7b5d0a16d48332c61617eec 100644 (file)
--- a/rust-bindings/rust/src/lib.rs
+++ b/rust-bindings/rust/src/lib.rs
@@ -5,6 +5,9 @@
 //! along with a layer for deploying them and managing the bootloader configuration.
 
 #![cfg_attr(feature = "dox", feature(doc_cfg))]
+#![deny(unused_must_use)]
+#![warn(missing_docs)]
+#![warn(rustdoc::broken_intra_doc_links)]
 
 // Re-export our dependencies.  See https://gtk-rs.org/blog/2021/06/22/new-release.html
 // "Dependencies are re-exported".  Users will need e.g. `gio::File`, so this avoids
@@ -16,6 +19,7 @@ pub use glib;
 #[rustfmt::skip]
 #[allow(clippy::all)]
 #[allow(unused_imports)]
+#[allow(missing_docs)]
 mod auto;
 pub use crate::auto::functions::*;
 pub use crate::auto::*;
@@ -62,7 +66,7 @@ pub use crate::sysroot_deploy_tree_opts::SysrootDeployTreeOpts;
 #[cfg(test)]
 mod tests;
 
-// prelude
+/// Prelude, intended for glob imports.
 pub mod prelude {
     pub use crate::auto::traits::*;
     // See "Re-export dependencies above".

diff --git a/rust-bindings/rust/src/repo.rs b/rust-bindings/rust/src/repo.rs
index 4b683716ed8a4a37db13a907e23da226a93089d2..ba5ab14fff640f736c6d87ed2f61948d9b7ebfd0 100644 (file)
--- a/rust-bindings/rust/src/repo.rs
+++ b/rust-bindings/rust/src/repo.rs
@@ -41,6 +41,7 @@ impl Repo {
         Repo::new(&gio::File::for_path(path.as_ref()))
     }
 
+    /// Find all objects reachable from a commit.
     pub fn traverse_commit<P: IsA<gio::Cancellable>>(
         &self,
         commit_checksum: &str,
@@ -66,6 +67,7 @@ impl Repo {
         }
     }
 
+    /// List all branch names (refs).
     pub fn list_refs<P: IsA<gio::Cancellable>>(
         &self,
         refspec_prefix: Option<&str>,
@@ -117,6 +119,7 @@ impl Repo {
         }
     }
 
+    /// Write a content object from provided input.
     pub fn write_content<P: IsA<gio::InputStream>, Q: IsA<gio::Cancellable>>(
         &self,
         expected_checksum: Option<&str>,
@@ -144,6 +147,7 @@ impl Repo {
         }
     }
 
+    /// Write a metadata object.
     pub fn write_metadata<P: IsA<gio::Cancellable>>(
         &self,
         objtype: ObjectType,
@@ -171,6 +175,7 @@ impl Repo {
         }
     }
 
+    /// Asynchronously write a content object.
     pub fn write_content_async<
         P: IsA<gio::InputStream>,
         Q: IsA<gio::Cancellable>,
@@ -222,6 +227,7 @@ impl Repo {
         }
     }
 
+    /// Asynchronously write a content object.
     pub fn write_content_async_future<P: IsA<gio::InputStream> + Clone + 'static>(
         &self,
         expected_checksum: Option<&str>,
@@ -245,6 +251,7 @@ impl Repo {
         }))
     }
 
+    /// Asynchronously write a metadata object.
     pub fn write_metadata_async<
         P: IsA<gio::Cancellable>,
         Q: FnOnce(Result<Checksum, Error>) + Send + 'static,
@@ -295,6 +302,7 @@ impl Repo {
         }
     }
 
+    /// Asynchronously write a metadata object.
     pub fn write_metadata_async_future(
         &self,
         objtype: ObjectType,

diff --git a/rust-bindings/rust/src/se_policy.rs b/rust-bindings/rust/src/se_policy.rs
index 6ec9cfe166e191a1baef340fa389c55a66d98e83..43f8c11facbfe862712a714930b5c5825557baf1 100644 (file)
--- a/rust-bindings/rust/src/se_policy.rs
+++ b/rust-bindings/rust/src/se_policy.rs
@@ -2,6 +2,7 @@ use crate::SePolicy;
 use std::ptr;
 
 impl SePolicy {
+    /// Reset the SELinux filesystem creation context.
     pub fn fscreatecon_cleanup() {
         unsafe {
             ffi::ostree_sepolicy_fscreatecon_cleanup(ptr::null_mut());